browserify-zlib

Description

Emulates Node’s zlib module for the browser. Can be used as a drop in replacement with Browserify and webpack.

The heavy lifting is done using pako. The code in this module is modeled closely after the code in the source of Node core to get as much compatability as possible.

API

https://nodejs.org/api/zlib.html

Not implemented

The following options/methods are not supported because pako does not support them yet.

• The params method

get-caller-file

This is a utility, which allows a function to figure out from which file it was invoked. It does so by inspecting v8’s stack trace at the time it is invoked.

Inspired by http://stackoverflow.com/questions/13227489

note: this relies on Node/V8 specific APIs, as such other runtimes may not work

Installation

yarn add get-caller-file

Usage

Given:

// ./foo.js
const getCallerFile = require('get-caller-file');

module.exports = function() {
  return getCallerFile(); // figures out who called it
};

// index.js
const foo = require('./foo');

foo() // => /full/path/to/this/file/index.js

Options:

• getCallerFile(position = 2): where position is stack frame whos fileName we want.

create-hmac

Node style HMACs for use in the browser, with native HMAC functions in node. API is the same as HMACs in node:

var createHmac = require('create-hmac')
var hmac = createHmac('sha224', Buffer.from('secret key'))
hmac.update('synchronous write') //optional encoding parameter
hmac.digest() // synchronously get result with optional encoding parameter

hmac.write('write to it as a stream')
hmac.end() //remember it's a stream
hmac.read() //only if you ended it as a stream though

is-error

Detect whether a value is an error

Example

var isError = require("is-error");

console.log(isError(new Error('hi'))) // true
console.log(isError({ message: 'hi' })) // false

Docs

var bool = isError(maybeErr)

is-error := (maybeErr: Any) => Boolean

isError returns a boolean. it will detect whether the argument is an error or not.

Installation

npm install is-error

Tests

npm test

• Raynos

buffer-equal-constant-time

Constant-time Buffer comparison for node.js. Should work with browserify too.

  npm install buffer-equal-constant-time

Usage

  var bufferEq = require('buffer-equal-constant-time');

  var a = new Buffer('asdf');
  var b = new Buffer('asdf');
  if (bufferEq(a,b)) {
    // the same!
  } else {
    // different in at least one byte!
  }

If you’d like to install an .equal() method onto the node.js Buffer and SlowBuffer prototypes:

  require('buffer-equal-constant-time').install();

  var a = new Buffer('asdf');
  var b = new Buffer('asdf');
  if (a.equal(b)) {
    // the same!
  } else {
    // different in at least one byte!
  }

To get rid of the installed .equal() method, call .restore():

  require('buffer-equal-constant-time').restore();

lodash v4.17.20

The Lodash library exported as Node.js modules.

Installation

Using npm:

npm i -g npm
npm i --save lodash

In Node.js:

// Load the full build.
var _ = require('lodash');
// Load the core build.
var _ = require('lodash/core');
// Load the FP build for immutable auto-curried iteratee-first data-last methods.
var fp = require('lodash/fp');

// Load method categories.
var array = require('lodash/array');
var object = require('lodash/fp/object');

// Cherry-pick methods for smaller browserify/rollup/webpack bundles.
var at = require('lodash/at');
var curryN = require('lodash/fp/curryN');

See the package source for more details.

Note:
Install n_ for Lodash use in the Node.js < 6 REPL.

Tested in Chrome 74-75, Firefox 66-67, IE 11, Edge 18, Safari 11-12, & Node.js 8-12.
Automated browser & CI test runs are available.

md5.js

Node style md5 on pure JavaScript.

From NIST SP 800-131A: md5 is no longer acceptable where collision resistance is required such as digital signatures.

Example

var MD5 = require('md5.js')

console.log(new MD5().update('42').digest('hex'))
// => a1d0c6e83f027327d8461063f4ac58a6

var md5stream = new MD5()
md5stream.end('42')
console.log(md5stream.read().toString('hex'))
// => a1d0c6e83f027327d8461063f4ac58a6

DES.js

Brorand

Miller-Rabin

base64-js

base64-js does basic base64 encoding/decoding in pure JS.

Many browsers already have base64 encoding/decoding functionality, but it is for text data, not all-purpose binary data.

Sometimes encoding/decoding binary data in the browser is useful, and that is what this module does.

install

With npm do:

npm install base64-js and var base64js = require('base64-js')

For use in web browsers do:

<script src="base64js.min.js"></script>

Get supported base64-js with the Tidelift Subscription

methods

base64js has three exposed functions, byteLength, toByteArray and fromByteArray, which both take a single argument.

• byteLength - Takes a base64 string and returns length of byte array
• toByteArray - Takes a base64 string and returns a byte array
• fromByteArray - Takes a byte array and returns a base64 string

Fast Diff

This is a simplified import of the excellent diff-match-patch library by Neil Fraser into the Node.js environment. The match and patch parts are removed, as well as all the extra diff options. What remains is incredibly fast diffing between two strings.

The diff function is an implementation of “An O(ND) Difference Algorithm and its Variations” (Myers, 1986) with the suggested divide and conquer strategy along with several optimizations Neil added.

var diff = require('fast-diff');

var good = 'Good dog';
var bad = 'Bad dog';

var result = diff(good, bad);
// [[-1, "Goo"], [1, "Ba"], [0, "d dog"]]

// Respect suggested edit location (cursor position), added in v1.1
diff('aaa', 'aaaa', 1)
// [[0, "a"], [1, "a"], [0, "aa"]]

// For convenience
diff.INSERT === 1;
diff.EQUAL === 0;
diff.DELETE === -1;

eslint-rule-docs

Find documentation url for a given ESLint rule. Updated daily!

Install

$ npm install eslint-rule-docs

Usage

const getRuleUrl = require('eslint-rule-docs');

// Find url for core rules
getRuleUrl('no-undef');
// => { exactMatch: true, url: 'https://eslint.org/docs/rules/no-undef' }

// Find url for known plugins
getRuleUrl('react/sort-prop-types');
// => { exactMatch: true, url: 'https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/sort-prop-types.md' }

// If the plugin has no documentation, return repository url 
getRuleUrl('flowtype/semi');
// => { exactMatch: false, url: 'https://github.com/gajus/eslint-plugin-flowtype' }

// If the plugin is unknown, returns an empty object
getRuleUrl('unknown-foo/bar');
// => {}

atob

Uses Buffer to emulate the exact functionality of the browser’s atob.

Note: Unicode may be handled incorrectly (like the browser).

It turns base64-encoded ascii data back to binary.

(function () {
  "use strict";

  var atob = require('atob');
  var b64 = "SGVsbG8sIFdvcmxkIQ==";
  var bin = atob(b64);

  console.log(bin); // "Hello, World!"
}());

Check out unibabel.js

Changelog

• v2.1.0 address a few issues and PRs, update URLs
• v2.0.0 provide browser version for ios web workers
• v1.2.0 provide (empty) browser version
• v1.1.2 node only

Docs released under Creative Commons.

Caseless – wrap an object to set and get property with caseless semantics but also preserve caseing.

This library is incredibly useful when working with HTTP headers. It allows you to get/set/check for headers in a caseless manner while also preserving the caseing of headers the first time they are set.

Usage

var headers = {}
  , c = caseless(headers)
  ;
c.set('a-Header', 'asdf')
c.get('a-header') === 'asdf'

has(key)

Has takes a name and if it finds a matching header will return that header name with the preserved caseing it was set with.

c.has('a-header') === 'a-Header'

set(key, value[, clobber=true])

Set is fairly straight forward except that if the header exists and clobber is disabled it will add ','+value to the existing header.

c.set('a-Header', 'fdas')
c.set('a-HEADER', 'more', false)
c.get('a-header') === 'fdsa,more'

swap(key)

Swaps the casing of a header with the new one that is passed in.

var headers = {}
  , c = caseless(headers)
  ;
c.set('a-Header', 'fdas')
c.swap('a-HEADER')
c.has('a-header') === 'a-HEADER'
headers === {'a-HEADER': 'fdas'}

confusing-browser-globals

A curated list of browser globals that commonly cause confusion and are not recommended to use without an explicit window. qualifier.

Motivation

Some global variables in browser are likely to be used by people without the intent of using them as globals, such as status, name, event, etc.

For example:

handleClick() { // missing `event` argument
  this.setState({
    text: event.target.value // uses the `event` global: oops!
  });
}

This package exports a list of globals that are often used by mistake. You can feed this list to a static analysis tool like ESLint to prevent their usage without an explicit window. qualifier.

Installation

npm install --save confusing-browser-globals

Usage

If you use Create React App, you don’t need to configure anything, as this rule is already included in the default eslint-config-react-app preset.

If you maintain your own ESLint configuration, you can do this:

var restrictedGlobals = require('confusing-browser-globals');

module.exports = {
  rules: {
    'no-restricted-globals': ['error'].concat(restrictedGlobals),
  },
};

js-string-escape

Escape any string to be a valid JavaScript string literal between double quotes or single quotes.

Installation

npm install js-string-escape

Example

If you need to generate JavaScript output, this library will help you safely put arbitrary data in JavaScript strings:

jsStringEscape = require('js-string-escape')

console.log('"' + jsStringEscape('Quotes (\", \'), newlines (\n), etc.') + '"')
// => "Quotes (\", \'), newlines (\n), etc."

In other words, given any string s, the following invariants hold:

eval('"' + jsStringEscape(s) + '"') === s
eval("'" + jsStringEscape(s) + "'") === s

These eval expressions are safe with untrusted strings s.

Non-strings will be cast to strings.

Compliance

This library has been checked against ECMAScript 5.1 and tested against all Unicode code points.

Overview

Adds support for the timers module to browserify.

Wait, isn’t it already supported in the browser?

The public methods of the timers module are:

• setTimeout(callback, delay, [arg], [...])
• clearTimeout(timeoutId)
• setInterval(callback, delay, [arg], [...])
• clearInterval(intervalId)

and indeed, browsers support these already.

So, why does this exist?

The timers module also includes some private methods used in other built-in Node.js modules:

• enroll(item, delay)
• unenroll(item)
• active(item)

These are used to efficiently support a large quantity of timers with the same timeouts by creating only a few timers under the covers.

Node.js also offers the immediate APIs, which aren’t yet available cross-browser, so we polyfill those:

• setImmediate(callback, [arg], [...])
• clearImmediate(immediateId)

I need lots of timers and want to use linked list timers as Node.js does.

Linked lists are efficient when you have thousands (millions?) of timers with the same delay. Take a look at timers-browserify-full in this case.

node-asn1 is a library for encoding and decoding ASN.1 datatypes in pure JS. Currently BER encoding is supported; at some point I’ll likely have to do DER.

Usage

Mostly, if you’re actually needing to read and write ASN.1, you probably don’t need this readme to explain what and why. If you have no idea what ASN.1 is, see this: ftp://ftp.rsa.com/pub/pkcs/ascii/layman.asc

The source is pretty much self-explanatory, and has read/write methods for the common types out there.

Decoding

The following reads an ASN.1 sequence with a boolean.

var Ber = require('asn1').Ber;

var reader = new Ber.Reader(Buffer.from([0x30, 0x03, 0x01, 0x01, 0xff]));

reader.readSequence();
console.log('Sequence len: ' + reader.length);
if (reader.peek() === Ber.Boolean)
  console.log(reader.readBoolean());

Encoding

The following generates the same payload as above.

var Ber = require('asn1').Ber;

var writer = new Ber.Writer();

writer.startSequence();
writer.writeBoolean(true);
writer.endSequence();

console.log(writer.buffer);

Installation

npm install asn1

Bugs

See https://github.com/joyent/node-asn1/issues.

Merge Descriptors

Merge objects using descriptors.

var thing = {
  get name() {
    return 'jon'
  }
}

var animal = {

}

merge(animal, thing)

animal.name === 'jon'

API

merge(destination, source)

Redefines destination’s descriptors with source’s.

merge(destination, source, false)

Defines source’s descriptors on destination if destination does not have a descriptor by the same name.

SPDX

From version 2.0 of the SPDX specification:

The Linux Foundation and the SPDX working groups are good people. Only they decide what “SPDX” means, as a standard and otherwise. I respect their work and their rights. You should, too.

This Package

I created this package by copying exception identifiers out of the SPDX specification. That work was mechanical, routine, and required no creativity whatsoever. - Kyle Mitchell, package author

United States users concerned about intellectual property may wish to discuss the following Supreme Court decisions with their attorneys:

Array Flatten

Flatten an array of nested arrays into a single flat array. Accepts an optional depth.

Installation

npm install array-flatten --save

Usage

var flatten = require('array-flatten')

flatten([1, [2, [3, [4, [5], 6], 7], 8], 9])
//=> [1, 2, 3, 4, 5, 6, 7, 8, 9]

flatten([1, [2, [3, [4, [5], 6], 7], 8], 9], 2)
//=> [1, 2, 3, [4, [5], 6], 7, 8, 9]

(function () {
  flatten(arguments) //=> [1, 2, 3]
})(1, [2, 3])

unpipe

Unpipe a stream from all destinations.

Installation

$ npm install unpipe

API

var unpipe = require('unpipe')

unpipe(stream)

Unpipes all destinations from a given stream. With stream 2+, this is equivalent to stream.unpipe(). When used with streams 1 style streams (typically Node.js 0.8 and below), this module attempts to undo the actions done in stream.pipe(dest).

json-stringify-safe

Like JSON.stringify, but doesn’t throw on circular references.

Usage

Takes the same arguments as JSON.stringify.

var stringify = require('json-stringify-safe');
var circularObj = {};
circularObj.circularRef = circularObj;
circularObj.list = [ circularObj, circularObj ];
console.log(stringify(circularObj, null, 2));

Output:

{
  "circularRef": "[Circular]",
  "list": [
    "[Circular]",
    "[Circular]"
  ]
}

Details

stringify(obj, serializer, indent, decycler)

The first three arguments are the same as to JSON.stringify. The last is an argument that’s only used when the object has been seen already.

The default decycler function returns the string '[Circular]'. If, for example, you pass in function(k,v){} (return nothing) then it will prune cycles. If you pass in function(k,v){ return {foo: 'bar'}}, then cyclical objects will always be represented as {"foo":"bar"} in the result.

stringify.getSerialize(serializer, decycler)

Returns a serializer that can be used elsewhere. This is the actual function that’s passed to JSON.stringify.

Note that the function returned from getSerialize is stateful for now, so do not use it more than once.

Deep Extend

Recursive object extending.

Install

$ npm install deep-extend

Usage

var deepExtend = require('deep-extend');
var obj1 = {
  a: 1,
  b: 2,
  d: {
    a: 1,
    b: [],
    c: { test1: 123, test2: 321 }
  },
  f: 5,
  g: 123,
  i: 321,
  j: [1, 2]
};
var obj2 = {
  b: 3,
  c: 5,
  d: {
    b: { first: 'one', second: 'two' },
    c: { test2: 222 }
  },
  e: { one: 1, two: 2 },
  f: [],
  g: (void 0),
  h: /abc/g,
  i: null,
  j: [3, 4]
};

deepExtend(obj1, obj2);

console.log(obj1);
/*
{ a: 1,
  b: 3,
  d:
   { a: 1,
     b: { first: 'one', second: 'two' },
     c: { test1: 123, test2: 222 } },
  f: [],
  g: undefined,
  c: 5,
  e: { one: 1, two: 2 },
  h: /abc/g,
  i: null,
  j: [3, 4] }
*/

Unit testing

$ npm test

Changelog

CHANGELOG.md

Any issues?

Please, report about issues here.

is-ci

Returns true if the current environment is a Continuous Integration server.

Please open an issue if your CI server isn’t properly detected :)

Installation

npm install is-ci --save

Programmatic Usage

const isCI = require('is-ci')

if (isCI) {
  console.log('The code is running on a CI server')
}

CLI Usage

For CLI usage you need to have the is-ci executable in your PATH. There’s a few ways to do that:

• Either install the module globally using npm install is-ci -g
• Or add the module as a dependency to your app in which case it can be used inside your package.json scripts as is
• Or provide the full path to the executable, e.g. ./node_modules/.bin/is-ci

is-ci && echo "This is a CI server"

Refer to ci-info docs for all supported CI’s

utils-merge

Merges the properties from a source object into a destination object.

Install

$ npm install utils-merge

Usage

var a = { foo: 'bar' }
  , b = { bar: 'baz' };

merge(a, b);
// => { foo: 'bar', bar: 'baz' }

eslint-import-resolver-node

Default Node-style module resolution plugin for eslint-plugin-import.

Published separately to allow pegging to a specific version in case of breaking changes.

Config is passed directly through to resolve as options:

settings:
  import/resolver:
    node:
      extensions:
        # if unset, default is just '.js', but it must be re-added explicitly if set
        - .js
        - .jsx
        - .es6
        - .coffee

      paths:
        # an array of absolute paths which will also be searched
        # think NODE_PATH
        - /usr/local/share/global_modules

      # this is technically for identifying `node_modules` alternate names
      moduleDirectory:

        - node_modules # defaults to 'node_modules', but...
        - bower_components

        - project/src  # can add a path segment here that will act like
                       # a source root, for in-project aliasing (i.e.
                       # `import MyStore from 'stores/my-store'`)

or to use the default options:

settings:
  import/resolver: node

is-core-module

Is this specifier a node.js core module? Optionally provide a node version to check; defaults to the current node version.

Example

var isCore = require('is-core-module');
var assert = require('assert');
assert(isCore('fs'));
assert(!isCore('butts'));

Tests

Clone the repo, npm install, and run npm test

signal-exit

When you want to fire an event no matter how a process exits:

• reaching the end of execution.
• explicitly having process.exit(code) called.
• having process.kill(pid, sig) called.
• receiving a fatal signal from outside the process

Use signal-exit.

var onExit = require('signal-exit')

onExit(function (code, signal) {
  console.log('process exited!')
})

API

var remove = onExit(function (code, signal) {}, options)

The return value of the function is a function that will remove the handler.

Note that the function only fires for signals if the signal would cause the proces to exit. That is, there are no other listeners, and it is a fatal signal.

Options

• alwaysLast: Run this handler after any other signal or exit handlers. This causes process.emit to be monkeypatched.

which

Like the unix which utility.

Finds the first instance of a specified executable in the PATH environment variable. Does not cache the results, so hash -r is not needed when the PATH changes.

USAGE

var which = require('which')

// async usage
which('node', function (er, resolvedPath) {
  // er is returned if no "node" is found on the PATH
  // if it is found, then the absolute path to the exec is returned
})

// or promise
which('node').then(resolvedPath => { ... }).catch(er => { ... not found ... })

// sync usage
// throws if not found
var resolved = which.sync('node')

// if nothrow option is used, returns null if not found
resolved = which.sync('node', {nothrow: true})

// Pass options to override the PATH and PATHEXT environment vars.
which('node', { path: someOtherPath }, function (er, resolved) {
  if (er)
    throw er
  console.log('found at %j', resolved)
})

CLI USAGE

Same as the BSD which(1) binary.

usage: which [-as] program ...

OPTIONS

You may pass an options object as the second argument.

• path: Use instead of the PATH environment variable.
• pathExt: Use instead of the PATHEXT environment variable.
• all: Return all matches, instead of just the first one. Note that this means the function returns an array of strings instead of a single string.

extsprintf: extended POSIX-style sprintf

Stripped down version of s[n]printf(3c). We make a best effort to throw an exception when given a format string we don’t understand, rather than ignoring it, so that we won’t break existing programs if/when we go implement the rest of this.

This implementation currently supports specifying

• field alignment (‘-’ flag),
• zero-pad (‘0’ flag)
• always show numeric sign (‘+’ flag),
• field width
• conversions for strings, decimal integers, and floats (numbers).
• argument size specifiers. These are all accepted but ignored, since Javascript has no notion of the physical size of an argument.

Everything else is currently unsupported, most notably: precision, unsigned numbers, non-decimal numbers, and characters.

Besides the usual POSIX conversions, this implementation supports:

• %j: pretty-print a JSON object (using node’s “inspect”)
• %r: pretty-print an Error object

Example

First, install it:

# npm install extsprintf

Now, use it:

var mod_extsprintf = require('extsprintf');
console.log(mod_extsprintf.sprintf('hello %25s', 'world'));

outputs:

hello                     world

Also supported

printf: same args as sprintf, but prints the result to stdout

fprintf: same args as sprintf, preceded by a Node stream. Prints the result to the given stream.

process

require('process'); just like any other module.

Works in node.js and browsers via the browser.js shim provided with the module.

browser implementation

The goal of this module is not to be a full-fledged alternative to the builtin process module. This module mostly exists to provide the nextTick functionality and little more. We keep this module lean because it will often be included by default by tools like browserify when it detects a module has used the process global.

It also exposes a “browser” member (i.e. process.browser) which is true in this implementation but undefined in node. This can be used in isomorphic code that adjusts it’s behavior depending on which environment it’s running in.

If you are looking to provide other process methods, I suggest you monkey patch them onto the process global in your app. A list of user created patches is below.

• hrtime
• stdout

package manager notes

If you are writing a bundler to package modules for client side use, make sure you use the browser field hint in package.json.

See https://gist.github.com/4339901 for details.

The browserify module will properly handle this field when bundling your files.

common-path-prefix

Computes the longest prefix string that is common to each path, excluding the base component. Tested with Node.js 8 and above.

Installation

npm install common-path-prefix

Usage

The module has one default export, the commonPathPrefix function:

const commonPathPrefix = require('common-path-prefix')

Call commonPathPrefix() with an array of paths (strings) and an optional separator character:

const paths = ['templates/main.handlebars', 'templates/_partial.handlebars']

commonPathPrefix(paths, '/') // returns 'templates/'

If the separator is not provided the first / or \ found in any of the paths is used. Otherwise the platform-default value is used:

commonPathPrefix(['templates/main.handlebars', 'templates/_partial.handlebars']) // returns 'templates/'
commonPathPrefix(['templates\\main.handlebars', 'templates\\_partial.handlebars']) // returns 'templates\\'

You can provide any separator, for example:

commonPathPrefix(['foo$bar', 'foo$baz'], '$') // returns 'foo$''

An empty string is returned if no common prefix exists:

commonPathPrefix(['foo/bar', 'baz/qux']) // returns ''
commonPathPrefix(['foo/bar']) // returns ''

Note that the following does have a common prefix:

commonPathPrefix(['/foo/bar', '/baz/qux']) // returns '/'

isexe

Minimal module to check if a file is executable, and a normal file.

Uses fs.stat and tests against the PATHEXT environment variable on Windows.

USAGE

var isexe = require('isexe')
isexe('some-file-name', function (err, isExe) {
  if (err) {
    console.error('probably file does not exist or something', err)
  } else if (isExe) {
    console.error('this thing can be run')
  } else {
    console.error('cannot be run')
  }
})

// same thing but synchronous, throws errors
var isExe = isexe.sync('some-file-name')

// treat errors as just "not executable"
isexe('maybe-missing-file', { ignoreErrors: true }, callback)
var isExe = isexe.sync('maybe-missing-file', { ignoreErrors: true })

API

isexe(path, [options], [callback])

Check if the path is executable. If no callback provided, and a global Promise object is available, then a Promise will be returned.

Will raise whatever errors may be raised by fs.stat, unless options.ignoreErrors is set to true.

isexe.sync(path, [options])

Same as isexe but returns the value and throws any errors raised.

Options

• ignoreErrors Treat all errors as “no, this is not executable”, but don’t raise them.
• uid Number to use as the user id
• gid Number to use as the group id
• pathExt List of path extensions to use instead of PATHEXT environment variable on Windows.

#is-symbol

Is this an ES6 Symbol value?

Example

var isSymbol = require('is-symbol');
assert(!isSymbol(function () {}));
assert(!isSymbol(null));
assert(!isSymbol(function* () { yield 42; return Infinity; });

assert(isSymbol(Symbol.iterator));
assert(isSymbol(Symbol('foo')));
assert(isSymbol(Symbol.for('foo')));
assert(isSymbol(Object(Symbol('foo'))));

Tests

Simply clone the repo, npm install, and run npm test

ci-parallel-vars

Get CI environment variables for parallelizing builds

Install

yarn add ci-parallel-vars

Usage

const ciParallelVars = require('ci-parallel-vars');

console.log(ciParallelVars); // { index: 3, total: 10 } || null

If you want to add support for another pair, please open a pull request and add them to index.js and to this list.

• Knapsack / TravisCI / GitLab - CI_NODE_INDEX/CI_NODE_TOTAL
• CircleCI - CIRCLE_NODE_INDEX/CIRCLE_NODE_TOTAL
• Bitbucket Pipelines - BITBUCKET_PARALLEL_STEP/BITBUCKET_PARALLEL_STEP_COUNT
• Buildkite - BUILDKITE_PARALLEL_JOB/BUILDKITE_PARALLEL_JOB_COUNT
• Semaphore - SEMAPHORE_CURRENT_JOB/SEMAPHORE_JOB_COUNT

One of these pairs must both be defined as numbers or ci-parallel-vars will be null.

function-bind

Implementation of function.prototype.bind

Example

I mainly do this for unit tests I run on phantomjs. PhantomJS does not have Function.prototype.bind :(

Function.prototype.bind = require("function-bind")

Installation

npm install function-bind

• Raynos

SocketPool.swf

Some special networking features can optionally use a Flash component. Building the output SWF file requires the Flex SDK. A pre-built component is included: swf/SocketPool.swf.

Building the output SWF requires the mxmlc tool from the Flex SDK. If that tools is already installed then look in the package.json file for the commands to rebuild it. If you need the SDK installed, there is a npm module that installs it:

npm install

To build a regular component:

npm run build

Additional debug support can be built in with the following:

npm run build-debug

Policy Server

Flash support requires the use of a Policy Server.

Apache Flash Socket Policy Module

mod_fsp provides an Apache module that can serve up a Flash Socket Policy. See mod_fsp/README for more details. This module makes it easy to modify an Apache server to allow cross domain requests to be made to it.

Simple Python Policy Server

policyserver.py provides a very simple test policy server.

Simple Node.js Policy Server

policyserver.js provides a very simple test policy server. If a server is needed for production environments, please use another option such as perhaps nodejs_socket_policy_server.

ESLint Scope

ESLint Scope is the ECMAScript scope analyzer used in ESLint. It is a fork of escope.

Usage

Install:

npm i eslint-scope --save

Example:

var eslintScope = require('eslint-scope');
var espree = require('espree');
var estraverse = require('estraverse');

var ast = espree.parse(code);
var scopeManager = eslintScope.analyze(ast);

var currentScope = scopeManager.acquire(ast);   // global scope

estraverse.traverse(ast, {
    enter: function(node, parent) {
        // do stuff

        if (/Function/.test(node.type)) {
            currentScope = scopeManager.acquire(node);  // get current function scope
        }
    },
    leave: function(node, parent) {
        if (/Function/.test(node.type)) {
            currentScope = currentScope.upper;  // set to parent scope
        }

        // do stuff
    }
});

Contributing

Issues and pull requests will be triaged and responded to as quickly as possible. We operate under the ESLint Contributor Guidelines, so please be sure to read them before contributing. If you’re not sure where to dig in, check out the issues.

Build Commands

• npm test - run all linting and tests
• npm run lint - run all linting

hash.js

Just a bike-shed.

Install

npm install hash.js

Usage

var hash = require('hash.js')
hash.sha256().update('abc').digest('hex')

Selective hash usage

var sha512 = require('hash.js/lib/hash/sha/512');
sha512().update('abc').digest('hex');

eslint-utils

🏁 Goal

This package provides utility functions and classes for make ESLint custom rules.

For examples:

• getStaticValue evaluates static value on AST.
• ReferenceTracker checks the members of modules/globals as handling assignments and destructuring.

📖 Usage

See documentation.

📰 Changelog

See releases.

❤️ Contributing

Welcome contributing!

Please use GitHub’s Issues/PRs.

Development Tools

• npm test runs tests and measures coverage.
• npm run clean removes the coverage result of npm test command.
• npm run coverage shows the coverage result of the last npm test command.
• npm run lint runs ESLint.
• npm run watch runs tests on each file change.

node-http-signature

node-http-signature is a node.js library that has client and server components for Joyent’s HTTP Signature Scheme.

Usage

Note the example below signs a request with the same key/cert used to start an HTTP server. This is almost certainly not what you actually want, but is just used to illustrate the API calls; you will need to provide your own key management in addition to this library.

Client

var fs = require('fs');
var https = require('https');
var httpSignature = require('http-signature');

var key = fs.readFileSync('./key.pem', 'ascii');

var options = {
  host: 'localhost',
  port: 8443,
  path: '/',
  method: 'GET',
  headers: {}
};

// Adds a 'Date' header in, signs it, and adds the
// 'Authorization' header in.
var req = https.request(options, function(res) {
  console.log(res.statusCode);
});


httpSignature.sign(req, {
  key: key,
  keyId: './cert.pem'
});

req.end();

Server

var fs = require('fs');
var https = require('https');
var httpSignature = require('http-signature');

var options = {
  key: fs.readFileSync('./key.pem'),
  cert: fs.readFileSync('./cert.pem')
};

https.createServer(options, function (req, res) {
  var rc = 200;
  var parsed = httpSignature.parseRequest(req);
  var pub = fs.readFileSync(parsed.keyId, 'ascii');
  if (!httpSignature.verifySignature(parsed, pub))
    rc = 401;

  res.writeHead(rc);
  res.end();
}).listen(8443);

Installation

npm install http-signature

Bugs

See https://github.com/joyent/node-http-signature/issues.

pbkdf2

This library provides the functionality of PBKDF2 with the ability to use any supported hashing algorithm returned from crypto.getHashes()

Usage

var pbkdf2 = require('pbkdf2')
var derivedKey = pbkdf2.pbkdf2Sync('password', 'salt', 1, 32, 'sha512')

...

For more information on the API, please see the relevant Node documentation.

For high performance, use the async variant (pbkdf2.pbkdf2), not pbkdf2.pbkdf2Sync, this variant has the oppurtunity to use window.crypto.subtle when browserified.

Credits

This module is a derivative of cryptocoinjs/pbkdf2-sha256, so thanks to JP Richardson for laying the ground work.

Thank you to FangDun Cai for donating the package name on npm, if you’re looking for his previous module it is located at fundon/pbkdf2.

jsbn: javascript big number

Tom Wu’s Original Website

I felt compelled to put this on github and publish to npm. I haven’t tested every other big integer library out there, but the few that I have tested in comparison to this one have not even come close in performance. I am aware of the bi module on npm, however it has been modified and I wanted to publish the original without modifications. This is jsbn and jsbn2 from Tom Wu’s original website above, with the modular pattern applied to prevent global leaks and to allow for use with node.js on the server side.

usage

var BigInteger = require('jsbn');

var a = new BigInteger('91823918239182398123');
alert(a.bitLength()); // 67

API

bi.toString()

returns the base-10 number as a string

bi.negate()

returns a new BigInteger equal to the negation of bi

bi.abs

returns new BI of absolute value

bi.compareTo

bi.bitLength

bi.mod

bi.modPowInt

bi.clone

bi.intValue

bi.byteValue

bi.shortValue

bi.signum

bi.toByteArray

bi.equals

bi.min

bi.max

bi.and

bi.or

bi.xor

bi.andNot

bi.not

bi.shiftLeft

bi.shiftRight

bi.getLowestSetBit

bi.bitCount

bi.testBit

bi.setBit

bi.clearBit

bi.flipBit

bi.add

bi.subtract

bi.multiply

bi.divide

bi.remainder

bi.divideAndRemainder

bi.modPow

bi.modInverse

bi.pow

bi.gcd

bi.isProbablePrime

#is-regex

Is this value a JS regex? This module works cross-realm/iframe, and despite ES6 @@toStringTag.

Example

var isRegex = require('is-regex');
var assert = require('assert');

assert.notOk(isRegex(undefined));
assert.notOk(isRegex(null));
assert.notOk(isRegex(false));
assert.notOk(isRegex(true));
assert.notOk(isRegex(42));
assert.notOk(isRegex('foo'));
assert.notOk(isRegex(function () {}));
assert.notOk(isRegex([]));
assert.notOk(isRegex({}));

assert.ok(isRegex(/a/g));
assert.ok(isRegex(new RegExp('a', 'g')));

Tests

Simply clone the repo, npm install, and run npm test

Browser-friendly inheritance fully compatible with standard node.js inherits.

This package exports standard inherits from node.js util module in node environment, but also provides alternative browser-friendly implementation through browser field. Alternative implementation is a literal copy of standard one located in standalone module to avoid requiring of util. It also has a shim for old browsers with no Object.create support.

While keeping you sure you are using standard inherits implementation in node.js environment, it allows bundlers such as browserify to not include full util package to your client code if all you need is just inherits function. It worth, because browser shim for util package is large and inherits is often the single function you need from it.

It’s recommended to use this package instead of require('util').inherits for any code that has chances to be used not only in node.js but in browser too.

usage

var inherits = require('inherits');
// then use exactly as the standard one

note on version ~1.0

Version ~1.0 had completely different motivation and is not compatible neither with 2.0 nor with standard node.js inherits.

If you are using version ~1.0 and planning to switch to ~2.0, be careful:

• new version uses super_ instead of super for referencing superclass
• new version overwrites current prototype while old one preserves any existing fields on it

Browser-friendly inheritance fully compatible with standard node.js inherits.

This package exports standard inherits from node.js util module in node environment, but also provides alternative browser-friendly implementation through browser field. Alternative implementation is a literal copy of standard one located in standalone module to avoid requiring of util. It also has a shim for old browsers with no Object.create support.

While keeping you sure you are using standard inherits implementation in node.js environment, it allows bundlers such as browserify to not include full util package to your client code if all you need is just inherits function. It worth, because browser shim for util package is large and inherits is often the single function you need from it.

It’s recommended to use this package instead of require('util').inherits for any code that has chances to be used not only in node.js but in browser too.

usage

var inherits = require('inherits');
// then use exactly as the standard one

note on version ~1.0

Version ~1.0 had completely different motivation and is not compatible neither with 2.0 nor with standard node.js inherits.

If you are using version ~1.0 and planning to switch to ~2.0, be careful:

• new version uses super_ instead of super for referencing superclass
• new version overwrites current prototype while old one preserves any existing fields on it

Browser-friendly inheritance fully compatible with standard node.js inherits.

This package exports standard inherits from node.js util module in node environment, but also provides alternative browser-friendly implementation through browser field. Alternative implementation is a literal copy of standard one located in standalone module to avoid requiring of util. It also has a shim for old browsers with no Object.create support.

While keeping you sure you are using standard inherits implementation in node.js environment, it allows bundlers such as browserify to not include full util package to your client code if all you need is just inherits function. It worth, because browser shim for util package is large and inherits is often the single function you need from it.

It’s recommended to use this package instead of require('util').inherits for any code that has chances to be used not only in node.js but in browser too.

usage

var inherits = require('inherits');
// then use exactly as the standard one

note on version ~1.0

Version ~1.0 had completely different motivation and is not compatible neither with 2.0 nor with standard node.js inherits.

If you are using version ~1.0 and planning to switch to ~2.0, be careful:

• new version uses super_ instead of super for referencing superclass
• new version overwrites current prototype while old one preserves any existing fields on it

find-root

recursively find the closest package.json

usage

Say you want to check if the directory name of a project matches its module name in package.json:

const path = require('path')
const findRoot = require('find-root')

// from a starting directory, recursively search for the nearest
// directory containing package.json
const root = findRoot('/Users/jsdnxx/Code/find-root/tests')
// => '/Users/jsdnxx/Code/find-root'

const dirname = path.basename(root)
console.log('is it the same?')
console.log(dirname === require(path.join(root, 'package.json')).name)

You can also pass in a custom check function (by default, it checks for the existence of package.json in a directory). In this example, we traverse up to find the root of a git repo:

const fs = require('fs')

const gitRoot = findRoot('/Users/jsdnxx/Code/find-root/tests', function (dir) {
  return fs.existsSync(path.resolve(dir, '.git'))
})

api

findRoot: (startingPath : string, check?: (dir: string) => boolean) => string

Returns the path for the nearest directory to startingPath containing a package.json file, eg /foo/module.

If check is provided, returns the path for the closest parent directory where check returns true.

Throws an error if no package.json is found at any level in the startingPath.

installation

> npm install find-root

running the tests

From package root:

> npm install
> npm test

contributors

• jsdnxx

forwarded

Parse HTTP X-Forwarded-For header

Installation

This is a Node.js module available through the npm registry. Installation is done using the npm install command:

$ npm install forwarded

API

var forwarded = require('forwarded')

forwarded(req)

var addresses = forwarded(req)

Parse the X-Forwarded-For header from the request. Returns an array of the addresses, including the socket address for the req, in reverse order (i.e. index 0 is the socket address and the last index is the furthest address, typically the end-user).

Testing

$ npm test

crypto-browserify

A port of node’s crypto module to the browser.

The goal of this module is to reimplement node’s crypto module, in pure javascript so that it can run in the browser.

Here is the subset that is currently implemented:

• createHash (sha1, sha224, sha256, sha384, sha512, md5, rmd160)
• createHmac (sha1, sha224, sha256, sha384, sha512, md5, rmd160)
• pbkdf2
• pbkdf2Sync
• randomBytes
• pseudoRandomBytes
• createCipher (aes)
• createDecipher (aes)
• createDiffieHellman
• createSign (rsa, ecdsa)
• createVerify (rsa, ecdsa)
• createECDH (secp256k1)
• publicEncrypt/privateDecrypt (rsa)
• privateEncrypt/publicDecrypt (rsa)

todo

these features from node’s crypto are still unimplemented.

• createCredentials

contributions

If you are interested in writing a feature, please implement as a new module, which will be incorporated into crypto-browserify as a dependency.

All deps must be compatible with node’s crypto (generate example inputs and outputs with node, and save base64 strings inside JSON, so that tests can run in the browser. see sha.js

Crypto is extra serious so please do not hesitate to review the code, and post comments if you do.

HAR Validator

Extremely fast HTTP Archive (HAR) validator using JSON Schema.

Install

npm install har-validator

CLI Usage

Please refer to har-cli for more info.

API

Note: as of v2.0.0 this module defaults to Promise based API. For backward compatibility with v1.x an async/callback API is also provided

• async API
• callback API
• Promise API (default)

ieee754

Read/write IEEE754 floating point numbers from/to a Buffer or array-like object.

install

npm install ieee754

methods

var ieee754 = require('ieee754')

The ieee754 object has the following functions:

ieee754.read = function (buffer, offset, isLE, mLen, nBytes)
ieee754.write = function (buffer, value, offset, isLE, mLen, nBytes)

The arguments mean the following:

• buffer = the buffer
• offset = offset into the buffer
• value = value to set (only for write)
• isLe = is little endian?
• mLen = mantissa length
• nBytes = number of bytes

what is ieee754?

The IEEE Standard for Floating-Point Arithmetic (IEEE 754) is a technical standard for floating-point computation. Read more.

mute-stream

Bytes go in, but they don’t come out (when muted).

This is a basic pass-through stream, but when muted, the bytes are silently dropped, rather than being passed through.

Usage

var MuteStream = require('mute-stream')

var ms = new MuteStream(options)

ms.pipe(process.stdout)
ms.write('foo') // writes 'foo' to stdout
ms.mute()
ms.write('bar') // does not write 'bar'
ms.unmute()
ms.write('baz') // writes 'baz' to stdout

// can also be used to mute incoming data
var ms = new MuteStream
input.pipe(ms)

ms.on('data', function (c) {
  console.log('data: ' + c)
})

input.emit('data', 'foo') // logs 'foo'
ms.mute()
input.emit('data', 'bar') // does not log 'bar'
ms.unmute()
input.emit('data', 'baz') // logs 'baz'

Options

All options are optional.

• replace Set to a string to replace each character with the specified string when muted. (So you can show **** instead of the password, for example.)

• prompt If you are using a replacement char, and also using a prompt with a readline stream (as for a Password: ***** input), then specify what the prompt is so that backspace will work properly. Otherwise, pressing backspace will overwrite the prompt with the replacement character, which is weird.

ms.mute()

Set muted to true. Turns .write() into a no-op.

ms.unmute()

Set muted to false

ms.isTTY

True if the pipe destination is a TTY, or if the incoming pipe source is a TTY.

Other stream methods…

The other standard readable and writable stream methods are all available. The MuteStream object acts as a facade to its pipe source and destination.

util-deprecate

The Node.js util.deprecate() function with browser support

In Node.js, this module simply re-exports the util.deprecate() function.

In the web browser (i.e. via browserify), a browser-specific implementation of the util.deprecate() function is used.

API

A deprecate() function is the only thing exposed by this module.

// setup:
exports.foo = deprecate(foo, 'foo() is deprecated, use bar() instead');


// users see:
foo();
// foo() is deprecated, use bar() instead
foo();
foo();

constants-browserify

Node’s constants module for the browser.

Usage

To use with browserify cli:

$ browserify -r constants:constants-browserify script.js

To use with browserify api:

browserify()
  .require('constants-browserify', { expose: 'constants' })
  .add(__dirname + '/script.js')
  .bundle()
  // ...

Installation

With npm do

$ npm install constants-browserify

Port of the OpenBSD bcrypt_pbkdf function to pure Javascript. npm-ified version of Devi Mandiri’s port, with some minor performance improvements. The code is copied verbatim (and un-styled) from Devi’s work.

API

bcrypt_pbkdf.pbkdf(pass, passlen, salt, saltlen, key, keylen, rounds)

Derive a cryptographic key of arbitrary length from a given password and salt, using the OpenBSD bcrypt_pbkdf function. This is a combination of Blowfish and SHA-512.

See this article for further information.

Parameters:

• pass, a Uint8Array of length passlen
• passlen, an integer Number
• salt, a Uint8Array of length saltlen
• saltlen, an integer Number
• key, a Uint8Array of length keylen, will be filled with output
• keylen, an integer Number
• rounds, an integer Number, number of rounds of the PBKDF to run

bcrypt_pbkdf.hash(sha2pass, sha2salt, out)

Calculate a Blowfish hash, given SHA2-512 output of a password and salt. Used as part of the inner round function in the PBKDF.

Parameters:

• sha2pass, a Uint8Array of length 64
• sha2salt, a Uint8Array of length 64
• out, a Uint8Array of length 32, will be filled with output

Methods

HTTP verbs that Node.js core’s HTTP parser supports.

This module provides an export that is just like http.METHODS from Node.js core, with the following differences:

• All method names are lower-cased.
• Contains a fallback list of methods for Node.js versions that do not have a http.METHODS export (0.10 and lower).
• Provides the fallback list when using tools like browserify without pulling in the http shim module.

Install

$ npm install methods

API

var methods = require('methods')

methods

This is an array of lower-cased method names that Node.js supports. If Node.js provides the http.METHODS export, then this is the same array lower-cased, otherwise it is a snapshot of the verbs from Node.js 0.10.

end-of-stream

A node module that calls a callback when a readable/writable/duplex stream has completed or failed.

npm install end-of-stream

Usage

Simply pass a stream and a callback to the eos. Both legacy streams, streams2 and stream3 are supported.

var eos = require('end-of-stream');

eos(readableStream, function(err) {
  // this will be set to the stream instance
    if (err) return console.log('stream had an error or closed early');
    console.log('stream has ended', this === readableStream);
});

eos(writableStream, function(err) {
    if (err) return console.log('stream had an error or closed early');
    console.log('stream has finished', this === writableStream);
});

eos(duplexStream, function(err) {
    if (err) return console.log('stream had an error or closed early');
    console.log('stream has ended and finished', this === duplexStream);
});

eos(duplexStream, {readable:false}, function(err) {
    if (err) return console.log('stream had an error or closed early');
    console.log('stream has finished but might still be readable');
});

eos(duplexStream, {writable:false}, function(err) {
    if (err) return console.log('stream had an error or closed early');
    console.log('stream has ended but might still be writable');
});

eos(readableStream, {error:false}, function(err) {
    // do not treat emit('error', err) as a end-of-stream
});

Related

end-of-stream is part of the mississippi stream utility collection which includes more useful stream modules similar to this one.

hash-base

Abstract base class to inherit from if you want to create streams implementing the same API as node crypto Hash (for Cipher / Decipher check crypto-browserify/cipher-base).

Example

const HashBase = require('hash-base')
const inherits = require('inherits')

// our hash function is XOR sum of all bytes
function MyHash () {
  HashBase.call(this, 1) // in bytes

  this._sum = 0x00
}

inherits(MyHash, HashBase)

MyHash.prototype._update = function () {
  for (let i = 0; i < this._block.length; ++i) this._sum ^= this._block[i]
}

MyHash.prototype._digest = function () {
  return this._sum
}

const data = Buffer.from([ 0x00, 0x42, 0x01 ])
const hash = new MyHash().update(data).digest()
console.log(hash) // => 67

You also can check source code or crypto-browserify/md5.js

toidentifier

Convert a string of words to a JavaScript identifier

Install

This is a Node.js module available through the npm registry. Installation is done using the npm install command:

$ npm install toidentifier

Example

var toIdentifier = require('toidentifier')

console.log(toIdentifier('Bad Request'))
// => "BadRequest"

API

This CommonJS module exports a single default function: toIdentifier.

toIdentifier(string)

Given a string as the argument, it will be transformed according to the following rules and the new string will be returned:

1. Split into words separated by space characters (0x20).
2. Upper case the first character of each word.
3. Join the words together with no separator.
4. Remove all non-word ([0-9a-z_]) characters.

pump

pump is a small node module that pipes streams together and destroys all of them if one of them closes.

npm install pump

What problem does it solve?

When using standard source.pipe(dest) source will not be destroyed if dest emits close or an error. You are also not able to provide a callback to tell when then pipe has finished.

pump does these two things for you

Usage

Simply pass the streams you want to pipe together to pump and add an optional callback

var pump = require('pump')
var fs = require('fs')

var source = fs.createReadStream('/dev/random')
var dest = fs.createWriteStream('/dev/null')

pump(source, dest, function(err) {
  console.log('pipe finished', err)
})

setTimeout(function() {
  dest.destroy() // when dest is closed pump will destroy source
}, 1000)

You can use pump to pipe more than two streams together as well

var transform = someTransformStream()

pump(source, transform, anotherTransform, dest, function(err) {
  console.log('pipe finished', err)
})

If source, transform, anotherTransform or dest closes all of them will be destroyed.

Similarly to stream.pipe(), pump() returns the last stream passed in, so you can do:

return pump(s1, s2) // returns s2

If you want to return a stream that combines both s1 and s2 to a single stream use pumpify instead.

Related

pump is part of the mississippi stream utility collection which includes more useful stream modules similar to this one.

hmac-drbg

JS-only implementation of HMAC DRBG.

Usage

const DRBG = require('hmac-drbg');
const hash = require('hash.js');

const d = new DRBG({
  hash: hash.sha256,
  entropy: '0123456789abcdef',
  nonce: '0123456789abcdef',
  pers: '0123456789abcdef' /* or `null` */
});

d.generate(32, 'hex');

is-buffer

Determine if an object is a Buffer (including the browserify Buffer)

Why not use Buffer.isBuffer?

This module lets you check if an object is a Buffer without using Buffer.isBuffer (which includes the whole buffer module in browserify).

It’s future-proof and works in node too!

install

npm install is-buffer

usage

var isBuffer = require('is-buffer')

isBuffer(new Buffer(4)) // true

isBuffer(undefined) // false
isBuffer(null) // false
isBuffer('') // false
isBuffer(true) // false
isBuffer(false) // false
isBuffer(0) // false
isBuffer(1) // false
isBuffer(1.0) // false
isBuffer('string') // false
isBuffer({}) // false
isBuffer(function foo () {}) // false

is-date-object

Is this value a JS Date object? This module works cross-realm/iframe, and despite ES6 @@toStringTag.

Example

var isDate = require('is-date-object');
var assert = require('assert');

assert.notOk(isDate(undefined));
assert.notOk(isDate(null));
assert.notOk(isDate(false));
assert.notOk(isDate(true));
assert.notOk(isDate(42));
assert.notOk(isDate('foo'));
assert.notOk(isDate(function () {}));
assert.notOk(isDate([]));
assert.notOk(isDate({}));
assert.notOk(isDate(/a/g));
assert.notOk(isDate(new RegExp('a', 'g')));

assert.ok(isDate(new Date()));

Tests

Simply clone the repo, npm install, and run npm test

is-negative-zero

Is this value negative zero? === will lie to you.

Example

var isNegativeZero = require('is-negative-zero');
var assert = require('assert');

assert.notOk(isNegativeZero(undefined));
assert.notOk(isNegativeZero(null));
assert.notOk(isNegativeZero(false));
assert.notOk(isNegativeZero(true));
assert.notOk(isNegativeZero(0));
assert.notOk(isNegativeZero(42));
assert.notOk(isNegativeZero(Infinity));
assert.notOk(isNegativeZero(-Infinity));
assert.notOk(isNegativeZero(NaN));
assert.notOk(isNegativeZero('foo'));
assert.notOk(isNegativeZero(function () {}));
assert.notOk(isNegativeZero([]));
assert.notOk(isNegativeZero({}));

assert.ok(isNegativeZero(-0));

Tests

Simply clone the repo, npm install, and run npm test

EVP_BytesToKey

The insecure key derivation algorithm from OpenSSL.

WARNING: DO NOT USE, except for compatibility reasons.

MD5 is insecure.

Use at least scrypt or pbkdf2-hmac-sha256 instead.

API

EVP_BytesToKey(password, salt, keyLen, ivLen)

• password - Buffer, password used to derive the key data.
• salt - 8 byte Buffer or null, salt is used as a salt in the derivation.
• keyBits - number, key length in bits.
• ivLen - number, iv length in bytes.

Returns: { key: Buffer, iv: Buffer }

Examples

MD5 with aes-256-cbc:

const crypto = require('crypto')
const EVP_BytesToKey = require('evp_bytestokey')

const result = EVP_BytesToKey(
  'my-secret-password',
  null,
  32,
  16
)
// =>
// { key: <Buffer e3 4f 96 f3 86 24 82 7c c2 5d ff 23 18 6f 77 72 54 45 7f 49 d4 be 4b dd 4f 6e 1b cc 92 a4 27 33>,
//   iv: <Buffer 85 71 9a bf ae f4 1e 74 dd 46 b6 13 79 56 f5 5b> }

const cipher = crypto.createCipheriv('aes-256-cbc', result.key, result.iv)

once

Only call a function once.

usage

var once = require('once')

function load (file, cb) {
  cb = once(cb)
  loader.load('file')
  loader.once('load', cb)
  loader.once('error', cb)
}

Or add to the Function.prototype in a responsible way:

// only has to be done once
require('once').proto()

function load (file, cb) {
  cb = cb.once()
  loader.load('file')
  loader.once('load', cb)
  loader.once('error', cb)
}

Ironically, the prototype feature makes this module twice as complicated as necessary.

To check whether you function has been called, use fn.called. Once the function is called for the first time the return value of the original function is saved in fn.value and subsequent calls will continue to return this value.

var once = require('once')

function load (cb) {
  cb = once(cb)
  var stream = createStream()
  stream.once('data', cb)
  stream.once('end', function () {
    if (!cb.called) cb(new Error('not found'))
  })
}

once.strict(func)

Throw an error if the function is called twice.

Some functions are expected to be called only once. Using once for them would potentially hide logical errors.

In the example below, the greet function has to call the callback only once:

function greet (name, cb) {
  // return is missing from the if statement
  // when no name is passed, the callback is called twice
  if (!name) cb('Hello anonymous')
  cb('Hello ' + name)
}

function log (msg) {
  console.log(msg)
}

// this will print 'Hello anonymous' but the logical error will be missed
greet(null, once(msg))

// once.strict will print 'Hello anonymous' and throw an error when the callback will be called the second time
greet(null, once.strict(msg))

sha.js

Node style SHA on pure JavaScript.

var shajs = require('sha.js')

console.log(shajs('sha256').update('42').digest('hex'))
// => 73475cb40a568e8da8a045ced110137e159f890ac4da883b6b17dc651b3a8049
console.log(new shajs.sha256().update('42').digest('hex'))
// => 73475cb40a568e8da8a045ced110137e159f890ac4da883b6b17dc651b3a8049

var sha256stream = shajs('sha256')
sha256stream.end('42')
console.log(sha256stream.read().toString('hex'))
// => 73475cb40a568e8da8a045ced110137e159f890ac4da883b6b17dc651b3a8049

supported hashes

sha.js currently implements:

• SHA (SHA-0) – legacy, do not use in new systems
• SHA-1 – legacy, do not use in new systems
• SHA-224
• SHA-256
• SHA-384
• SHA-512

Not an actual stream

Note, this doesn’t actually implement a stream, but wrapping this in a stream is trivial. It does update incrementally, so you can hash things larger than RAM, as it uses a constant amount of memory (except when using base64 or utf8 encoding, see code comments).

Acknowledgements

This work is derived from Paul Johnston’s A JavaScript implementation of the Secure Hash Algorithm.

compressible

Compressible Content-Type / mime checking.

Installation

$ npm install compressible

API

var compressible = require('compressible')

compressible(type)

Checks if the given Content-Type is compressible. The type argument is expected to be a value MIME type or Content-Type string, though no validation is performed.

The MIME is looked up in the mime-db and if there is compressible information in the database entry, that is returned. Otherwise, this module will fallback to true for the following types:

• text/*
• */*+json
• */*+text
• */*+xml

If this module is not sure if a type is specifically compressible or specifically uncompressible, undefined is returned.

compressible('text/html') // => true
compressible('image/png') // => false

string_decoder

Node-core v8.9.4 string_decoder for userland

npm install --save string_decoder

Node-core string_decoder for userland

This package is a mirror of the string_decoder implementation in Node-core.

Full documentation may be found on the Node.js website.

As of version 1.0.0 string_decoder uses semantic versioning.

Previous versions

Previous version numbers match the versions found in Node core, e.g. 0.10.24 matches Node 0.10.24, likewise 0.11.10 matches Node 0.11.10.

Update

The build/ directory contains a build script that will scrape the source from the nodejs/node repo given a specific Node version.

Streams Working Group

string_decoder is maintained by the Streams Working Group, which oversees the development and maintenance of the Streams API within Node.js. The responsibilities of the Streams Working Group include:

• Addressing stream issues on the Node.js issue tracker.
• Authoring and editing stream documentation within the Node.js project.
• Reviewing changes to stream subclasses within the Node.js project.
• Redirecting changes to streams from the Node.js project to this project.
• Assisting in the implementation of stream providers within Node.js.
• Recommending versions of readable-stream to be included in Node.js.
• Messaging about the future of streams to give the community advance notice of changes.

See readable-stream for more details.

string_decoder

Node-core v8.9.4 string_decoder for userland

npm install --save string_decoder

Node-core string_decoder for userland

This package is a mirror of the string_decoder implementation in Node-core.

Full documentation may be found on the Node.js website.

As of version 1.0.0 string_decoder uses semantic versioning.

Previous versions

Previous version numbers match the versions found in Node core, e.g. 0.10.24 matches Node 0.10.24, likewise 0.11.10 matches Node 0.11.10.

Update

The build/ directory contains a build script that will scrape the source from the nodejs/node repo given a specific Node version.

Streams Working Group

string_decoder is maintained by the Streams Working Group, which oversees the development and maintenance of the Streams API within Node.js. The responsibilities of the Streams Working Group include:

• Addressing stream issues on the Node.js issue tracker.
• Authoring and editing stream documentation within the Node.js project.
• Reviewing changes to stream subclasses within the Node.js project.
• Redirecting changes to streams from the Node.js project to this project.
• Assisting in the implementation of stream providers within Node.js.
• Recommending versions of readable-stream to be included in Node.js.
• Messaging about the future of streams to give the community advance notice of changes.

See readable-stream for more details.

has-symbols

Example

var hasSymbols = require('has-symbols');

hasSymbols() === true; // if the environment has native Symbol support. Not polyfillable, not forgeable.

var hasSymbolsKinda = require('has-symbols/shams');
hasSymbolsKinda() === true; // if the environment has a Symbol sham that mostly follows the spec.

• get-own-property-symbols npm | github
• core-js npm | github

Tests

Simply clone the repo, npm install, and run npm test

Dojo Themes

Package that contains a collection of Dojo themes.

Please Note: If you are looking for Dojo 1 themes, these have been relocated to @dojo/dijit-themes. The github url registered with bower has also been updated to point to the new repository, if you encounter any issues please run bower cache clean and try again.

Usage

With Dojo applications

1. Install @dojo/themes with npm i @dojo/themes.
2. Import the theme CSS into your project’s main.css: @import '~@dojo/themes/dojo/index.css.
3. Import the theme module and pass it to the widgets you need themed:

import theme from '@dojo/themes/dojo';

render() {
    return w(Button, { theme }, [ 'Hello World' ]);
}

With custom elements

1. Install @dojo/themes with npm i @dojo/themes.
2. Add the custom element-specific theme CSS to index.html: <link rel="stylesheet" href="node_modules/@dojo/themes/dojo/dojo-{version}.css">.
3. Add the custom element-specific theme JS to index.html: <script src="node_modules/@dojo/themes/dojo/dojo-{version}.js"></script>.

Composition

To compose and extend the themes within a dojo project, run npm i @dojo/themes and use the css-module composes functionality. Variables can be used by using @import to import the variables.css file from a theme. This functionality is added by a post-css plugin within the dojo build command.

/* myButton.m.css */
@import '@dojo/themes/dojo/variables.css';

.root {
    composes: root from '@dojo/themes/dojo/button.m.css';
    background-color: var(--dojo-green);
}

Generating typings

The following npm scripts are available to facilitate development:

• build:tcm: generate .m.css.d.ts files
• watch: generate .m.css.d.ts files in watch mode

eslint-plugin-eslint-comments

Additional ESLint rules for ESLint directive comments (e.g. //eslint-disable-line).

📖 Usage

• Documentation

🚥 Semantic Versioning Policy

eslint-plugin-eslint-comments follows semantic versioning and ESLint’s Semantic Versioning Policy.

📰 Changelog

• GitHub Releases

🍻 Contributing

Welcome contributing!

Please use GitHub’s Issues/PRs.

Development Tools

• npm test runs tests and measures coverage.
• npm run build updates README.md, index.js, and the header of all rule’s documents.
• npm run clean removes the coverage of the last npm test command.
• npm run coverage shows the coverage of the last npm test command.
• npm run lint runs ESLint for this codebase.
• npm run watch runs tests and measures coverage when source code are changed.

is-string

Is this value a JS String object or primitive? This module works cross-realm/iframe, and despite ES6 @@toStringTag.

Example

var isString = require('is-string');
var assert = require('assert');

assert.notOk(isString(undefined));
assert.notOk(isString(null));
assert.notOk(isString(false));
assert.notOk(isString(true));
assert.notOk(isString(function () {}));
assert.notOk(isString([]));
assert.notOk(isString({}));
assert.notOk(isString(/a/g));
assert.notOk(isString(new RegExp('a', 'g')));
assert.notOk(isString(new Date()));
assert.notOk(isString(42));
assert.notOk(isString(NaN));
assert.notOk(isString(Infinity));
assert.notOk(isString(new Number(42)));

assert.ok(isString('foo'));
assert.ok(isString(Object('foo')));

Tests

Simply clone the repo, npm install, and run npm test

reserved-words

What is it?

Tiny package for detecting reserved words.

Reserved Word is either a Keyword, or a Future Reserved Word, or a Null Literal, or a Boolean Literal. See: ES5 #7.6.1 and ES6 #11.6.2.

Installation

npm install reserved-words

API

check(word, [dialect], strict)

Returns true if provided identifier string is a Reserved Word in some ECMAScript dialect (ECMA-262 edition).

If the strict flag is truthy, this function additionally checks whether word is a Keyword or Future Reserved Word under strict mode.

Example

var reserved = require('reserved-words');
reserved.check('volatile', 'es3'); // true
reserved.check('volatile', 'es2015'); // false
reserved.check('yield', 3); // false
reserved.check('yield', 6); // true

dialects

es3 (or 3)

Represents ECMA-262 3rd edition.

See section 7.5.1.

es5 (or 5)

Represents ECMA-262 5th edition (ECMAScript 5.1).

Reserved Words are formally defined in ECMA262 sections 7.6.1.1 and 7.6.1.2.

es2015 (or es6, 6)

Represents ECMA-262 6th edition.

Reserved Words are formally defined in sections 11.6.2.1 and 11.6.2.2.

is-get-set-prop

Does a JS type have a getter/setter property

Install

npm install --save is-get-set-prop

Usage

ES2015

import isGetSetProp from 'is-get-set-prop';

isGetSetProp('array', 'length');
// => true

isGetSetProp('ARRAY', 'push');
// => false

// is-get-set-prop can only verify native JS types
isGetSetProp('gulp', 'task');
// => false;

ES5

var isGetSetProp = require('is-get-set-prop');

isGetSetProp('array', 'length');
// => true

isGetSetProp('ARRAY', 'push');
// => false

// is-get-set-prop can only verify native JS types
isGetSetProp('customObject', 'customGetterOrSetter');
// => false;

API

isGetSetProp(type, propertyName)

type

Type: string

A native JS type to examine. Note: is-get-set-prop can only verify native JS types.

propertyName

Type: string

Property name to determine if a getter/setter of type.

ecdsa-sig-formatter

Translate between JOSE and ASN.1/DER encodings for ECDSA signatures

Install

npm install ecdsa-sig-formatter --save

Usage

var format = require('ecdsa-sig-formatter');

var derSignature = '..'; // asn.1/DER encoded ecdsa signature

var joseSignature = format.derToJose(derSignature);

API

.derToJose(Buffer|String signature, String alg) -> String

Convert the ASN.1/DER encoded signature to a JOSE-style concatenated signature. Returns a base64 url encoded String.

• If signature is a String, it should be base64 encoded
• alg must be one of ES256, ES384 or ES512

.joseToDer(Buffer|String signature, String alg) -> Buffer

Convert the JOSE-style concatenated signature to an ASN.1/DER encoded signature. Returns a Buffer

• If signature is a String, it should be base64 url encoded
• alg must be one of ES256, ES384 or ES512

Contributing

1. Fork the repository. Committing directly against this repository is highly discouraged.

2. Make your modifications in a branch, updating and writing new unit tests as necessary in the spec directory.

3. Ensure that all tests pass with npm test

4. rebase your changes against master. Do not merge.

5. Submit a pull request to this repository. Wait for tests to run and someone to chime in.

Code Style

This repository is configured with EditorConfig and ESLint rules.

minimalistic-crypto-utils

Very minimal utils that are required in order to write reasonable JS-only crypto module.

Usage

const utils = require('minimalistic-crypto-utils');

utils.toArray('abcd', 'hex');
utils.encode([ 1, 2, 3, 4 ], 'hex');
utils.toHex([ 1, 2, 3, 4 ]);

isarray

Array#isArray for older browsers.

Usage

var isArray = require('isarray');

console.log(isArray([])); // => true
console.log(isArray({})); // => false

Installation

With npm do

$ npm install isarray

Then bundle for the browser with browserify.

With component do

$ component install juliangruber/isarray

pumpify

Combine an array of streams into a single duplex stream using pump and duplexify. If one of the streams closes/errors all streams in the pipeline will be destroyed.

npm install pumpify

Usage

Pass the streams you want to pipe together to pumpify pipeline = pumpify(s1, s2, s3, ...). pipeline is a duplex stream that writes to the first streams and reads from the last one. Streams are piped together using pump so if one of them closes all streams will be destroyed.

var pumpify = require('pumpify')
var tar = require('tar-fs')
var zlib = require('zlib')
var fs = require('fs')

var untar = pumpify(zlib.createGunzip(), tar.extract('output-folder'))
// you can also pass an array instead
// var untar = pumpify([zlib.createGunzip(), tar.extract('output-folder')])

fs.createReadStream('some-gzipped-tarball.tgz').pipe(untar)

If you are pumping object streams together use pipeline = pumpify.obj(s1, s2, ...). Call pipeline.destroy() to destroy the pipeline (including the streams passed to pumpify).

Using setPipeline(s1, s2, ...)

Similar to duplexify you can also define the pipeline asynchronously using setPipeline(s1, s2, ...)

var untar = pumpify()

setTimeout(function() {
  // will start draining the input now
  untar.setPipeline(zlib.createGunzip(), tar.extract('output-folder'))
}, 1000)

fs.createReadStream('some-gzipped-tarball.tgz').pipe(untar)

Related

pumpify is part of the mississippi stream utility collection which includes more useful stream modules similar to this one.

console-browserify

Emulate console for all the browsers

Install

You usually do not have to install console-browserify yourself! If your code runs in Node.js, console is built in. If your code runs in the browser, bundlers like browserify or webpack also include the console-browserify module when you do require('console').

But if none of those apply, with npm do:

npm install console-browserify

Usage

var console = require("console")
// Or when manually using console-browserify directly:
// var console = require("console-browserify")

console.log("hello world!")

API

See the Node.js Console docs. console-browserify does not support creating new Console instances and does not support the Inspector-only methods.

Contributing

PRs are very welcome! The main way to contribute to console-browserify is by porting features, bugfixes and tests from Node.js. Ideally, code contributions to this module are copy-pasted from Node.js and transpiled to ES5, rather than reimplemented from scratch. Matching the Node.js code as closely as possible makes maintenance simpler when new changes land in Node.js. This module intends to provide exactly the same API as Node.js, so features that are not available in the core console module will not be accepted. Feature requests should instead be directed at nodejs/node and will be added to this module once they are implemented in Node.js.

If there is a difference in behaviour between Node.js’s console module and this module, please open an issue!

• Raynos

pascalcase

Convert a string to pascal-case.

Install

Install with npm

$ npm i pascalcase --save

Usage

var pascalcase = require('pascalcase');

pascalcase('a');
//=> 'A'

pascalcase('foo bar baz');
//=> 'FooBarBaz'

pascalcase('foo_bar-baz');
//=> 'FooBarBaz'

pascalcase('foo.bar.baz');
//=> 'FooBarBaz'

pascalcase('foo/bar/baz');
//=> 'FooBarBaz'

pascalcase('foo[bar)baz');
//=> 'FooBarBaz'

pascalcase('#foo+bar*baz');
//=> 'FooBarBaz'

pascalcase('$foo~bar`baz');
//=> 'FooBarBaz'

pascalcase('_foo_bar-baz-');
//=> 'FooBarBaz'

Related projects

• justified: Wrap words to a specified length and justified the text.
• pad-left: Left pad a string with zeros or a specified string. Fastest implementation.
• pad-right: Right pad a string with zeros or a specified string. Fastest implementation.
• repeat-string: Repeat the given string n times. Fastest implementation for repeating a string.
• word-wrap: Wrap words to a specified length.

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

This file was generated by verb-cli on August 19, 2015. # responselike

A response-like object for mocking a Node.js HTTP response stream

Returns a streamable response object similar to a Node.js HTTP response stream. Useful for formatting cached responses so they can be consumed by code expecting a real response.

Install

npm install --save responselike

Or if you’re just using for testing you’ll want:

npm install --save-dev responselike

Usage

const Response = require('responselike');

const response = new Response(200, { foo: 'bar' }, Buffer.from('Hi!'), 'https://example.com');

response.statusCode;
// 200
response.headers;
// { foo: 'bar' }
response.body;
// <Buffer 48 69 21>
response.url;
// 'https://example.com'

response.pipe(process.stdout);
// Hi!

API

new Response(statusCode, headers, body, url)

Returns a streamable response object similar to a Node.js HTTP response stream.

statusCode

Type: number

HTTP response status code.

headers

Type: object

HTTP headers object. Keys will be automatically lowercased.

body

Type: buffer

A Buffer containing the response body. The Buffer contents will be streamable but is also exposed directly as response.body.

url

Type: string

Request URL string.

Acorn-JSX

This is plugin for Acorn - a tiny, fast JavaScript parser, written completely in JavaScript.

It was created as an experimental alternative, faster React.js JSX parser. Later, it replaced the official parser and these days is used by many prominent development tools.

Transpiler

Please note that this tool only parses source code to JSX AST, which is useful for various language tools and services. If you want to transpile your code to regular ES5-compliant JavaScript with source map, check out Babel and Buble transpilers which use acorn-jsx under the hood.

Usage

Requiring this module provides you with an Acorn plugin that you can use like this:

var acorn = require("acorn");
var jsx = require("acorn-jsx");
acorn.Parser.extend(jsx()).parse("my(<jsx/>, 'code');");

Note that official spec doesn’t support mix of XML namespaces and object-style access in tag names (#27) like in <namespace:Object.Property />, so it was deprecated in acorn-jsx@3.0. If you still want to opt-in to support of such constructions, you can pass the following option:

acorn.Parser.extend(jsx({ allowNamespacedObjects: true }))

Also, since most apps use pure React transformer, a new option was introduced that allows to prohibit namespaces completely:

acorn.Parser.extend(jsx({ allowNamespaces: false }))

Note that by default allowNamespaces is enabled for spec compliancy.

eslint-plugin-es

ESLint plugin which disallows each ECMAScript syntax.

🏁 Goal

Espree, the default parser of ESLint, has supported ecmaVersion option. However, it doesn’t support to enable each syntactic feature individually.

This plugin lets us disable each syntactic feature individually. So we can enable arbitrary syntactic features with the combination of ecmaVersion and this plugin.

📖 Usage

See documentation

🚥 Semantic Versioning Policy

This plugin follows semantic versioning and ESLint’s semantic versioning policy.

📰 Changelog

See releases.

❤️ Contributing

Welcome contributing!

Please use GitHub’s Issues/PRs.

Development Tools

• npm test runs tests and measures coverage.
• npm run clean removes the coverage result of npm test command.
• npm run coverage shows the coverage result of the last npm test command.
• npm run docs:build builds documentation.
• npm run docs:watch builds documentation on each file change.
• npm run watch runs tests on each file change.

extend-shallow

Extend an object with the properties of additional objects. node.js/javascript util.

Install

Install with npm

$ npm i extend-shallow --save

Usage

var extend = require('extend-shallow');

extend({a: 'b'}, {c: 'd'})
//=> {a: 'b', c: 'd'}

Pass an empty object to shallow clone:

var obj = {};
extend(obj, {a: 'b'}, {c: 'd'})
//=> {a: 'b', c: 'd'}

Related

• extend-shallow: Extend an object with the properties of additional objects. node.js/javascript util.
• for-own: Iterate over the own enumerable properties of an object, and return an object with properties… more
• for-in: Iterate over the own and inherited enumerable properties of an objecte, and return an object… more
• is-plain-object: Returns true if an object was created by the Object constructor.
• isobject: Returns true if the value is an object and not an array or null.
• kind-of: Get the native type of a value.

Running tests

Install dev dependencies:

$ npm i -d && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

This file was generated by verb-cli on June 29, 2015. # extend-shallow

Extend an object with the properties of additional objects. node.js/javascript util.

Install

Install with npm

$ npm i extend-shallow --save

Usage

var extend = require('extend-shallow');

extend({a: 'b'}, {c: 'd'})
//=> {a: 'b', c: 'd'}

Pass an empty object to shallow clone:

var obj = {};
extend(obj, {a: 'b'}, {c: 'd'})
//=> {a: 'b', c: 'd'}

Related

• extend-shallow: Extend an object with the properties of additional objects. node.js/javascript util.
• for-own: Iterate over the own enumerable properties of an object, and return an object with properties… more
• for-in: Iterate over the own and inherited enumerable properties of an objecte, and return an object… more
• is-plain-object: Returns true if an object was created by the Object constructor.
• isobject: Returns true if the value is an object and not an array or null.
• kind-of: Get the native type of a value.

Running tests

Install dev dependencies:

$ npm i -d && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

This file was generated by verb-cli on June 29, 2015. # extend-shallow

Extend an object with the properties of additional objects. node.js/javascript util.

Install

Install with npm

$ npm i extend-shallow --save

Usage

var extend = require('extend-shallow');

extend({a: 'b'}, {c: 'd'})
//=> {a: 'b', c: 'd'}

Pass an empty object to shallow clone:

var obj = {};
extend(obj, {a: 'b'}, {c: 'd'})
//=> {a: 'b', c: 'd'}

Related

• extend-shallow: Extend an object with the properties of additional objects. node.js/javascript util.
• for-own: Iterate over the own enumerable properties of an object, and return an object with properties… more
• for-in: Iterate over the own and inherited enumerable properties of an objecte, and return an object… more
• is-plain-object: Returns true if an object was created by the Object constructor.
• isobject: Returns true if the value is an object and not an array or null.
• kind-of: Get the native type of a value.

Running tests

Install dev dependencies:

$ npm i -d && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

This file was generated by verb-cli on June 29, 2015. # extend-shallow

Extend an object with the properties of additional objects. node.js/javascript util.

Install

Install with npm

$ npm i extend-shallow --save

Usage

var extend = require('extend-shallow');

extend({a: 'b'}, {c: 'd'})
//=> {a: 'b', c: 'd'}

Pass an empty object to shallow clone:

var obj = {};
extend(obj, {a: 'b'}, {c: 'd'})
//=> {a: 'b', c: 'd'}

Related

• extend-shallow: Extend an object with the properties of additional objects. node.js/javascript util.
• for-own: Iterate over the own enumerable properties of an object, and return an object with properties… more
• for-in: Iterate over the own and inherited enumerable properties of an objecte, and return an object… more
• is-plain-object: Returns true if an object was created by the Object constructor.
• isobject: Returns true if the value is an object and not an array or null.
• kind-of: Get the native type of a value.

Running tests

Install dev dependencies:

$ npm i -d && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

This file was generated by verb-cli on June 29, 2015. # extend-shallow

Extend an object with the properties of additional objects. node.js/javascript util.

Install

Install with npm

$ npm i extend-shallow --save

Usage

var extend = require('extend-shallow');

extend({a: 'b'}, {c: 'd'})
//=> {a: 'b', c: 'd'}

Pass an empty object to shallow clone:

var obj = {};
extend(obj, {a: 'b'}, {c: 'd'})
//=> {a: 'b', c: 'd'}

Related

• extend-shallow: Extend an object with the properties of additional objects. node.js/javascript util.
• for-own: Iterate over the own enumerable properties of an object, and return an object with properties… more
• for-in: Iterate over the own and inherited enumerable properties of an objecte, and return an object… more
• is-plain-object: Returns true if an object was created by the Object constructor.
• isobject: Returns true if the value is an object and not an array or null.
• kind-of: Get the native type of a value.

Running tests

Install dev dependencies:

$ npm i -d && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

This file was generated by verb-cli on June 29, 2015. # extend-shallow

Extend an object with the properties of additional objects. node.js/javascript util.

Install

Install with npm

$ npm i extend-shallow --save

Usage

var extend = require('extend-shallow');

extend({a: 'b'}, {c: 'd'})
//=> {a: 'b', c: 'd'}

Pass an empty object to shallow clone:

var obj = {};
extend(obj, {a: 'b'}, {c: 'd'})
//=> {a: 'b', c: 'd'}

Related

• extend-shallow: Extend an object with the properties of additional objects. node.js/javascript util.
• for-own: Iterate over the own enumerable properties of an object, and return an object with properties… more
• for-in: Iterate over the own and inherited enumerable properties of an objecte, and return an object… more
• is-plain-object: Returns true if an object was created by the Object constructor.
• isobject: Returns true if the value is an object and not an array or null.
• kind-of: Get the native type of a value.

Running tests

Install dev dependencies:

$ npm i -d && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

This file was generated by verb-cli on June 29, 2015. # registry-auth-token

Get the auth token set for an npm registry from .npmrc. Also allows fetching the configured registry URL for a given npm scope.

Installing

npm install --save registry-auth-token

Usage

Returns an object containing token and type, or undefined if no token can be found. type can be either Bearer or Basic.

var getAuthToken = require('registry-auth-token')
var getRegistryUrl = require('registry-auth-token/registry-url')

// Get auth token and type for default `registry` set in `.npmrc`
console.log(getAuthToken()) // {token: 'someToken', type: 'Bearer'}

// Get auth token for a specific registry URL
console.log(getAuthToken('//registry.foo.bar'))

// Find the registry auth token for a given URL (with deep path):
// If registry is at `//some.host/registry`
// URL passed is `//some.host/registry/deep/path`
// Will find token the closest matching path; `//some.host/registry`
console.log(getAuthToken('//some.host/registry/deep/path', {recursive: true}))

// Find the configured registry url for scope `@foobar`.
// Falls back to the global registry if not defined.
console.log(getRegistryUrl('@foobar'))

// Use the npm config that is passed in
console.log(getRegistryUrl('http://registry.foobar.eu/', {
  npmrc: {
    'registry': 'http://registry.foobar.eu/',
    '//registry.foobar.eu/:_authToken': 'qar'
  }
}))

Return value

// If auth info can be found:
{token: 'someToken', type: 'Bearer'}

// Or:
{token: 'someOtherToken', type: 'Basic'}

// Or, if nothing is found:
undefined

Security

Please be careful when using this. Leaking your auth token is dangerous.

es-to-primitive

ECMAScript “ToPrimitive” algorithm. Provides ES5 and ES2015 versions. When different versions of the spec conflict, the default export will be the latest version of the abstract operation. Alternative versions will also be available under an es5/es2015 exported property if you require a specific version.

Example

var toPrimitive = require('es-to-primitive');
var assert = require('assert');

assert(toPrimitive(function () {}) === String(function () {}));

var date = new Date();
assert(toPrimitive(date) === String(date));

assert(toPrimitive({ valueOf: function () { return 3; } }) === 3);

assert(toPrimitive(['a', 'b', 3]) === String(['a', 'b', 3]));

var sym = Symbol();
assert(toPrimitive(Object(sym)) === sym);

Tests

Simply clone the repo, npm install, and run npm test

universalify

Make a callback- or promise-based function support both promises and callbacks.

Uses the native promise implementation.

Installation

npm install universalify

API

universalify.fromCallback(fn)

Takes a callback-based function to universalify, and returns the universalified function.

Function must take a callback as the last parameter that will be called with the signature (error, result). universalify does not support calling the callback with three or more arguments, and does not ensure that the callback is only called once.

function callbackFn (n, cb) {
  setTimeout(() => cb(null, n), 15)
}

const fn = universalify.fromCallback(callbackFn)

// Works with Promises:
fn('Hello World!')
.then(result => console.log(result)) // -> Hello World!
.catch(error => console.error(error))

// Works with Callbacks:
fn('Hi!', (error, result) => {
  if (error) return console.error(error)
  console.log(result)
  // -> Hi!
})

universalify.fromPromise(fn)

Takes a promise-based function to universalify, and returns the universalified function.

Function must return a valid JS promise. universalify does not ensure that a valid promise is returned.

function promiseFn (n) {
  return new Promise(resolve => {
    setTimeout(() => resolve(n), 15)
  })
}

const fn = universalify.fromPromise(promiseFn)

// Works with Promises:
fn('Hello World!')
.then(result => console.log(result)) // -> Hello World!
.catch(error => console.error(error))

// Works with Callbacks:
fn('Hi!', (error, result) => {
  if (error) return console.error(error)
  console.log(result)
  // -> Hi!
})

universalify

Make a callback- or promise-based function support both promises and callbacks.

Uses the native promise implementation.

Installation

npm install universalify

API

universalify.fromCallback(fn)

Takes a callback-based function to universalify, and returns the universalified function.

Function must take a callback as the last parameter that will be called with the signature (error, result). universalify does not support calling the callback with three or more arguments, and does not ensure that the callback is only called once.

function callbackFn (n, cb) {
  setTimeout(() => cb(null, n), 15)
}

const fn = universalify.fromCallback(callbackFn)

// Works with Promises:
fn('Hello World!')
.then(result => console.log(result)) // -> Hello World!
.catch(error => console.error(error))

// Works with Callbacks:
fn('Hi!', (error, result) => {
  if (error) return console.error(error)
  console.log(result)
  // -> Hi!
})

universalify.fromPromise(fn)

Takes a promise-based function to universalify, and returns the universalified function.

Function must return a valid JS promise. universalify does not ensure that a valid promise is returned.

function promiseFn (n) {
  return new Promise(resolve => {
    setTimeout(() => resolve(n), 15)
  })
}

const fn = universalify.fromPromise(promiseFn)

// Works with Promises:
fn('Hello World!')
.then(result => console.log(result)) // -> Hello World!
.catch(error => console.error(error))

// Works with Callbacks:
fn('Hi!', (error, result) => {
  if (error) return console.error(error)
  console.log(result)
  // -> Hi!
})

jQuery

jQuery is a fast, small, and feature-rich JavaScript library.

For information on how to get started and how to use jQuery, please see jQuery’s documentation. For source files and issues, please visit the jQuery repo.

If upgrading, please see the blog post for 3.5.1. This includes notable differences from the previous version and a more readable changelog.

Including jQuery

Below are some of the most common ways to include jQuery.

Browser

Script tag

<script src="https://code.jquery.com/jquery-3.5.1.min.js"></script>

Babel

Babel is a next generation JavaScript compiler. One of the features is the ability to use ES6/ES2015 modules now, even though browsers do not yet support this feature natively.

import $ from "jquery";

Browserify/Webpack

There are several ways to use Browserify and Webpack. For more information on using these tools, please refer to the corresponding project’s documentation. In the script, including jQuery will usually look like this…

var $ = require( "jquery" );

AMD (Asynchronous Module Definition)

AMD is a module format built for the browser. For more information, we recommend require.js’ documentation.

define( [ "jquery" ], function( $ ) {

} );

Node

To include jQuery in Node, first install with npm.

npm install jquery

For jQuery to work in Node, a window with a document is required. Since no such window exists natively in Node, one can be mocked by tools such as jsdom. This can be useful for testing purposes.

const { JSDOM } = require( "jsdom" );
const { window } = new JSDOM( "" );
const $ = require( "jquery" )( window );

is-proto-prop

Does a JS type’s prototype have a property

Uses Sindre Sorhus’ proto-props

Install

npm install --save is-proto-prop

Usage

ES2015

import isProtoProp from 'is-proto-prop';

isProtoProp('array', 'length');
// => true

isProtoProp('Error', 'ignore');
// => false

// `is-proto-props` can only verify native JS types
isProtoProp('gulp', 'task');
// => false

ES5

var isProtoProp = require('is-proto-prop');

isProtoProp('array', 'length');
// => true

isProtoProp('Error', 'ignore');
// => false

// `is-proto-props` can only verify native JS types
isProtoProp('gulp', 'task');
// => false

API

isProtoProp(type, propertyName)

Returns a Boolean if propertyName is on type’s prototype.

type

type: string

JS type to examine the prototype of. Note: is-proto-prop only looks at native JS types.

propertyName

type: string

Property name to look for on type’s prototype. Note: propertyName is case sensitive.

performance-now

Implements a function similar to performance.now (based on process.hrtime).

Modern browsers have a window.performance object with - among others - a now method which gives time in milliseconds, but with sub-millisecond precision. This module offers the same function based on the Node.js native process.hrtime function.

According to the High Resolution Time specification, the number of milliseconds reported by performance.now should be relative to the value of performance.timing.navigationStart.

In the current version of the module (2.0) the reported time is relative to the time the current Node process has started (inferred from process.uptime()).

Version 1.0 reported a different time. The reported time was relative to the time the module was loaded (i.e. the time it was first required). If you need this functionality, version 1.0 is still available on NPM.

Example usage

var now = require("performance-now")
var start = now()
var end = now()
console.log(start.toFixed(3)) // the number of milliseconds the current node process is running
console.log((start-end).toFixed(3)) // ~ 0.002 on my system

Running the now function two times right after each other yields a time difference of a few microseconds. Given this overhead, I think it’s best to assume that the precision of intervals computed with this method is not higher than 10 microseconds, if you don’t know the exact overhead on your own system.

es-abstract

ECMAScript spec abstract operations. When different versions of the spec conflict, the default export will be the latest version of the abstract operation. All abstract operations will also be available under an es5/es2015/es2016/es2017/es2018/es2019 entry point, and exported property, if you require a specific version.

Example

var ES = require('es-abstract');
var assert = require('assert');

assert(ES.isCallable(function () {}));
assert(!ES.isCallable(/a/g));

Tests

Simply clone the repo, npm install, and run npm test

Security

Please email [@ljharb](https://github.com/ljharb) or see https://tidelift.com/security if you have a potential security vulnerability to report.

is-callable

Is this JS value callable? Works with Functions and GeneratorFunctions, despite ES6 @@toStringTag.

Example

var isCallable = require('is-callable');
var assert = require('assert');

assert.notOk(isCallable(undefined));
assert.notOk(isCallable(null));
assert.notOk(isCallable(false));
assert.notOk(isCallable(true));
assert.notOk(isCallable([]));
assert.notOk(isCallable({}));
assert.notOk(isCallable(/a/g));
assert.notOk(isCallable(new RegExp('a', 'g')));
assert.notOk(isCallable(new Date()));
assert.notOk(isCallable(42));
assert.notOk(isCallable(NaN));
assert.notOk(isCallable(Infinity));
assert.notOk(isCallable(new Number(42)));
assert.notOk(isCallable('foo'));
assert.notOk(isCallable(Object('foo')));

assert.ok(isCallable(function () {}));
assert.ok(isCallable(function* () {}));
assert.ok(isCallable(x => x * x));

Install

Install with

npm install is-callable

Tests

Simply clone the repo, npm install, and run npm test

clone-response

Clone a Node.js HTTP response stream

Returns a new stream and copies over all properties and methods from the original response giving you a complete duplicate.

This is useful in situations where you need to consume the response stream but also want to pass an unconsumed stream somewhere else to be consumed later.

Install

npm install --save clone-response

Usage

const http = require('http');
const cloneResponse = require('clone-response');

http.get('http://example.com', response => {
  const clonedResponse = cloneResponse(response);
  response.pipe(process.stdout);

  setImmediate(() => {
    // The response stream has already been consumed by the time this executes,
    // however the cloned response stream is still available.
    doSomethingWithResponse(clonedResponse);
  });
});

Please bear in mind that the process of cloning a stream consumes it. However, you can consume a stream multiple times in the same tick, therefore allowing you to create multiple clones. e.g:

const clone1 = cloneResponse(response);
const clone2 = cloneResponse(response);
// response can still be consumed in this tick but cannot be consumed if passed
// into any async callbacks. clone1 and clone2 can be passed around and be
// consumed in the future.

API

cloneResponse(response)

Returns a clone of the passed in response.

response

Type: stream

A Node.js HTTP response stream to clone.

JSON Schema for HTTP Archive (HAR).

Install

npm install --only=production --save har-schema

Usage

Compatible with any JSON Schema validation tool.

mime

Comprehensive MIME type mapping API based on mime-db module.

Install

Install with npm:

npm install mime

Contributing / Testing

npm run test